home *** CD-ROM | disk | FTP | other *** search
/ Aminet 6 / Aminet 6 - June 1995.iso / Aminet / util / time / TitleC1001_106.readme < prev    next >
Encoding:
Text File  |  1995-04-27  |  10.7 KB  |  270 lines
  1. Short:    WB Titleclock, very configurable
  2. Author:   henryk.richter@stud.uni-rostock.de
  3. Uploader: henryk.richter@stud.uni-rostock.de
  4. Type:     util/time
  5.  
  6.  
  7.                        TitleClock 1.06 (23-Feb-95)
  8.                        ---------------------------
  9.                         by Henryk "Buggs" Richter
  10.  
  11.  
  12. Purpose
  13. -------
  14.  
  15. TitleClock is just another little Workbench Title digital clock but this
  16. time with some special features. I know that there are 1000 other ones out
  17. doing the same job but mine can do a little bit more. It was written to
  18. be used in combination tools like with "MultiCX" by Martin Berndt to replace
  19. almost all really important functions of programs like "Kcommodity" but
  20. consuming much less memory. It works 100% conform to the style guide and
  21. does not patch any system function. So it should run on any machine equipped
  22. with OS2.x/3.x. 
  23.  
  24.  
  25. A short list of features:
  26. -------------------------
  27.  
  28. - almost completely configurable output, e.g.
  29.   "OutPutFormat=%W, Time: %h:%n:%s  %D-%m-%Y ->DFT Rulez<-" causes it showing
  30.   "Saturday, Time: 20:42:12  10-Dec-1994 ->DFT Rulez<-"
  31. - appears at the right side of the workbench title and doesn`t open a
  32.   disturbing window
  33. - Workbench screen may be closed meanwhile Titleclock is active so you can
  34.   change your prefs without having to close any window.
  35. - Supports a "MEM"-gauge with a variable size from 10 Pixels to 990 Pixels
  36.   wide + selectable memory type to show
  37. - The program is a commodity so you can control it using Commodities
  38.   Exchange.
  39. - Can be easily removed by starting it again or sending a "break" signal
  40.   using a usual system monitor.
  41. - 100% font sensitive
  42. - detects automatically the colors used in titlebar
  43. - comes along with Icons for NewIcons AND MagicWB
  44. - re-entrant, 100% PC relative code
  45. - locale support using the standard strings so that this program works with
  46.   every localized language (Kick 2.1+)
  47. - option to calculate the Stardate
  48. - quite short !! Hey, C and E programmers! Try to do this by using your
  49.   High-level languages, hehe
  50.  
  51.  
  52. Installation:
  53. -------------
  54.  
  55. Just drag the icon into the drawer you want. (usually sys:WBStartup)
  56.  
  57.  
  58. Starting:
  59. ---------
  60.  
  61. Double click onto the Icon. (What else)
  62.  
  63.  
  64. Configuration:
  65. --------------
  66.  
  67. The program countains no gui. This saves lots of memory from being wasted.
  68. Therefore the configuration is done using the tooltypes.
  69.  
  70.  
  71. OutPutFormat=????     Here you enter the line for your output string
  72.                       template. You may use any printable character and
  73.                       some offered variables. Those may be combined in any
  74.                       way you like (double, triple or even four times, no
  75.                       problem).
  76.                       The special variables:
  77.  
  78.                       %h -> hours in 24h military/European format
  79.                       %H -> hours in 12h American format
  80.                       %a -> "AM"/"PM"
  81.  
  82.                       %n -> minutes
  83.                       %s -> seconds
  84.  
  85.                       %D -> day
  86.  
  87.                       %N -> month as number
  88.                       %m -> month as short string (Jan,Feb,Mar...)
  89.                       %M -> month as string
  90.  
  91.                       %y -> year as 2 decimal numbers "94"
  92.                       %Y -> year as 4 decimal numbers "1994"
  93.  
  94.                       %w -> weekday as short string (Mon,Tue,Wed...)
  95.                       %W -> weekday as string
  96.  
  97.                       %% -> Just inserts a "%" char
  98.  
  99.                       %S -> Startrek TNG Stardate
  100.                             Descriptions of the algorithms can be found in
  101.                             the TNG and TOS Startrek FAQ`s
  102.                             Short explanation how I did it:
  103.                              example output: "05085.6"
  104.                             -the first digit is the current century (2"0"th)
  105.                             -the second is the Startrek season in the
  106.                              series and the movies. I used the last digit
  107.                              of the current year here since it is stated in
  108.                              the FAQ that this one increases every year
  109.                             -the next 3 digits are the portion of the
  110.                              current year from 0...999, which means:
  111.                              number of the current day (0..365) *1000/365
  112.                             -the ".6" represents the portion of the actual
  113.                              day divided through "2.4".
  114.                             If someone tells me how to convert gregorian
  115.                             date into the julian calendar, I`ll perhaps add
  116.                             an option for the TOS Stardate.
  117.  
  118.  
  119.  
  120.   Examples: OutPutFormat=Time: %h:%n%:%s  Date: %D-%M-%Y
  121.             OutPutFormat=This day is %h hours, %n minutes and %s seconds old
  122.             OutPutFormat=%W, %N-%D-%y %h:%n:%s
  123.  
  124. Gauge=??              This tooltype is for the mem bar showing the amount
  125.                       of free memory. If the (normally blue) bar reaches
  126.                       the right side, your memory is full. :(
  127.                       You may change the width of this gauge by entering
  128.                       values from 1 to 99. A value of 1 represents a width
  129.                       of 10 pixels.
  130.   Example: Gauge=5
  131.  
  132. Memtype=0x??          Here you can enter a c-style hexadecimal mask which
  133.                       type of mem is to be shown in the gauge. It works with
  134.                       standard exec-style Type definitions. (look into the
  135.                       examples, DUDE!)
  136.   Examples: Memtype=0x4   ... shows only free Fastmem
  137.             Memtype=0x2   ... shows only free Chipmem
  138.             Memtype=0x0   ... shows complete free memory
  139.             Memtype=0x1   ... shows Chip- and Fastmemory but not Virtual
  140.                               memory created e.g. by Gigamem® or VMM.
  141.             Memtype=0x20000 . shows largest free memory block
  142.             Memtype=0x20004 . shows largest free Fastmemory block
  143.             .
  144.             .
  145.             .
  146.  
  147.  
  148. Known Bugs / Problems
  149. ---------------------
  150.  
  151. Due to the display system blitting into the Workbench Titlebar Layer
  152. the display may disappear every time you change the current window or
  153. when the amount of free memory changes. I could change this behaviour
  154. but I didn`t want to open a window AND I hate too much patches.
  155.  
  156. If you set the Program`s "toolpri" lower than 0 it may/will happen that
  157. some programs using 100% of the CPU time (like PC-Task) can cause a 
  158. graphics deadlock. That happens when the blitter is already allocated by
  159. those functions used by Titleclock and then the CPU time is stolen by the
  160. Task with the higher priority. If you always use a priority of 5 (default
  161. setting) there shouldn`t be any problems. THE PROGRAM WILL NOT USE MORE 
  162. CPU TIME IN THIS CASE !
  163.  
  164.  
  165. History
  166. --------
  167.  
  168. 1.06 - the AM/PM showed 12 AM at high noon instead of 12 PM, fixed
  169.  
  170. 1.05 - added the Stardate(TM) option
  171.  
  172. 1.04 - fixed a minor bug, I just forgot to free the workbench screen`s
  173.        drawinfo structure
  174.      - added 12h / PM displaying modes since I were asked to
  175.      *not released*
  176.  
  177. 1.03 - wrote a version for Kickstart 2.0 (english only)
  178.      - from Kick 2.1 onwards now localization supported
  179.      - added some additional security checks
  180.      - added the memtype option for the mem-gauge
  181.      - little "bug" fixed causing some characters not to be deleted when
  182.        using certain proportional fonts (added a space of 6 pixels)
  183.  
  184. 1.02 - added a version with german strings, made the code re-entrant to 
  185.        save some bytes
  186.  
  187. 1.01 - added the mem-gauge
  188.  
  189. 1.00 - first non public testrelease
  190.  
  191.  
  192. Author
  193. ------
  194.  
  195.                          Henryk Richter
  196.                          (Buggs/Defect)
  197.                      Stephan Jantzen Ring 47
  198.                          18106 Rostock
  199.                             Germany
  200.  
  201.            E-MAIL: tfa652@cks1.rz.uni-rostock.de
  202.                    henryk.richter@stud.uni-rostock.de
  203.                    buggs@baltic.e-technik.uni-rostock.de
  204.  
  205.  
  206. Legal Stuff
  207. -----------
  208.  
  209. Titleclock IS Freeware, so use it the way you like.
  210.  
  211.  
  212. Copyright
  213. ---------
  214.  
  215. Titleclock is written and copyright © 1994 by Henryk Richter. No parts of
  216. this program may be altered in any way (this includes editing, re-
  217. programming, crunching, resourceing etc.), except archiving.
  218.  
  219.  
  220. Disclaimer
  221. ----------
  222.  
  223.    THERE  IS  NO  WARRANTY  FOR  THE  PROGRAMS,  TO  THE  EXTENT  PERMITTED BY
  224. APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS
  225. AND/OR  OTHER  PARTIES  PROVIDE  THE  PROGRAMS "AS IS" WITHOUT WARRANTY OF ANY
  226. KIND,  EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  227. WARRANTIES  OF  MERCHANTABILITY  AND  FITNESS  FOR  A PARTICULAR PURPOSE.  THE
  228. ENTIRE  RISK  AS  TO  THE QUALITY AND PERFORMANCE OF THE PROGRAMS IS WITH YOU.
  229. SHOULD  THE  PROGRAMS  PROVE  DEFECTIVE,  YOU ASSUME THE COST OF ALL NECESSARY
  230. SERVICING, REPAIR OR CORRECTION.
  231.  
  232.    IN  NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL
  233. ANY  COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY REDISTRIBUTE THE PROGRAMS AS
  234. PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL,
  235. INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
  236. THE PROGRAMS (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED
  237. INACCURATE  OR  LOSSES  SUSTAINED  BY YOU OR THIRD PARTIES OR A FAILURE OF THE
  238. PROGRAMS  TO  OPERATE  WITH  ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER
  239. PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
  240.  
  241. Shorter: use it on your own risk...
  242.  
  243.  
  244. Distribution
  245. ------------
  246.  
  247. The Distributor may only charge a fee up to the costs of obtaining any
  248. common public domain disk. The distributor agrees to stop distributing the
  249. programs and data involved on request of the author.  The distributor may
  250. only distribute an unmodified copy of the original program, with all the
  251. supplied documentation and copyright notices left intact. The amount of
  252. US $5 shouldn't be exceeded for a disk containing Titleclock.
  253.  
  254.  
  255. ============================= Archive contents =============================
  256.  
  257. Original  Packed Ratio    Date     Time    Name
  258. -------- ------- ----- --------- --------  -------------
  259.     3035    1314 56.7% 16-Feb-95 22:09:54  Titleclock1001.info
  260.     9989    4295 57.0% 23-Feb-95 13:09:24  Titleclock1001/TitleClock1001.doc
  261.     3040    2294 24.5% 05-Feb-95 17:20:58  Titleclock1001/TitleClock1001.doc.info
  262.     3300    2276 31.0% 21-Feb-95 00:07:24  Titleclock1001/TitleClock1001_2.0
  263.     3000    1546 48.4% 05-Feb-95 17:21:00  Titleclock1001/TitleClock1001_2.0.info
  264.     3164    2199 30.4% 21-Feb-95 00:07:16  Titleclock1001/TitleClock1001_2.1
  265.     3001    1548 48.4% 05-Feb-95 17:21:00  Titleclock1001/TitleClock1001_2.1.info
  266.     3048    2106 30.9% 21-Feb-95 00:07:08  Titleclock1001/TitleClock1001_3.x
  267.     3002    1551 48.3% 21-Feb-95 12:02:56  Titleclock1001/TitleClock1001_3.x.info
  268. -------- ------- ----- --------- --------
  269.    34579   19129 44.6% 23-Feb-95 21:19:30   9 files
  270.